﻿//-----------------------------------------------------------------------
// <copyright file="IMessagingService.cs" company="OOHM PROCESSAMENTO DE DADOS LTDA.">
//     Microsoft Public License (MS-PL) This license governs use of the accompanying
//     software. If you use the software, you accept this license. If you do not
//     accept the license, do not use the software. 1. Definitions The terms "reproduce,"
//     "reproduction," "derivative works," and "distribution" have the same meaning
//     here as under U.S. copyright law. A "contribution" is the original software,
//     or any additions or changes to the software. A "contributor" is any person
//     that distributes its contribution under this license. "Licensed patents"
//     are a contributor's patent claims that read directly on its contribution.
//     2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license,
//     including the license conditions and limitations in section 3, each contributor
//     grants you a non-exclusive, worldwide, royalty-free copyright license to
//     reproduce its contribution, prepare derivative works of its contribution,
//     and distribute its contribution or any derivative works that you create.
//     (B) Patent Grant- Subject to the terms of this license, including the license
//     conditions and limitations in section 3, each contributor grants you a non-exclusive,
//     worldwide, royalty-free license under its licensed patents to make, have
//     made, use, sell, offer for sale, import, and/or otherwise dispose of its
//     contribution in the software or derivative works of the contribution in
//     the software. 3. Conditions and Limitations (A) No Trademark License- This
//     license does not grant you rights to use any contributors' name, logo, or
//     trademarks. (B) If you bring a patent claim against any contributor over
//     patents that you claim are infringed by the software, your patent license
//     from such contributor to the software ends automatically. (C) If you distribute
//     any portion of the software, you must retain all copyright, patent, trademark,
//     and attribution notices that are present in the software. (D) If you distribute
//     any portion of the software in source code form, you may do so only under
//     this license by including a complete copy of this license with your distribution.
//     If you distribute any portion of the software in compiled or object code
//     form, you may only do so under a license that complies with this license.
//     (E) The software is licensed "as-is." You bear the risk of using it. The
//     contributors give no express warranties, guarantees or conditions. You may
//     have additional consumer rights under your local laws which this license
//     cannot change. To the extent permitted under your local laws, the contributors
//     exclude the implied warranties of merchantability, fitness for a particular
// </copyright>
//-----------------------------------------------------------------------
namespace AbstractSaaSTemplate.Domain.Services{    using System;
    using System.Collections.Generic;
    using AbstractSaaSTemplate.Domain.Models.Entities;
    using AbstractSaaSTemplate.Domain.Models.ValueObjects;

    /// <summary>
    /// Describes the contract for the 'Messaging' service.
    /// </summary>
    public interface IMessagingService : IService
    {
        /// <summary>
        /// Generates a welcome message with login instructions to the tenant administrator.
        /// </summary>
        /// <param name="senderUserId">The id of the user who is sending the message.</param>
        /// <param name="receiverTenantId">The id of the tenant who will receive the message.</param>
        /// <param name="receiverUserId">The id of the user who will receive the message.</param>
        /// <param name="callbackUrl">The url that drives the user back to the service from the e-mail.</param>
        /// <exception cref="MessagingUserCouldNotBeFoundException">Raised whenever the 'senderUserId' or the 'receiverUserId' does not find a matching User.</exception>
        /// <exception cref="MessagingTenantCouldNotBeFoundException">Raised whenever the 'receiverTenantId' does not find a matching Tenant.</exception>
        void SendWelcomeMessageForTenant(
            long senderUserId,
            long receiverTenantId,
            long receiverUserId,
            Uri callbackUrl);

        /// <summary>
        /// Generates a welcome message with login instructions to the account administrator.
        /// </summary>
        /// <param name="senderUserId">The id of the user who is sending the message.</param>
        /// <param name="receiverAccountId">The id of the tenant who will receive the message.</param>
        /// <param name="receiverUserId">The id of the user who will receive the message.</param>
        /// <param name="callbackUrl">The url that drives the user back to the service from the e-mail.</param>
        /// <exception cref="MessagingUserCouldNotBeFoundException">Raised whenever the 'senderUserId' or the 'receiverUserId' does not find a matching User.</exception>
        /// <exception cref="MessagingTenantCouldNotBeFoundException">Raised whenever the 'receiverAccountId' does not find a matching Account.</exception>
        void SendWelcomeMessageForAccount(
            long senderUserId,
            long receiverAccountId,
            long receiverUserId,
            Uri callbackUrl);
        
        /// <summary>
        /// Generates a new message from the template
        /// </summary>
        /// <typeparam name="TCustomData">The type of the custom data of the message (can be any value object inherited from MessageCustomData).</typeparam>
        /// <typeparam name="TDestination">The type of the destination (can be any value object inherited from MessageDestination).</typeparam>
        /// <param name="messageTemplate">The template which will be processed.</param>
        /// <param name="from">The origin of the message.</param>
        /// <param name="toList">The list of receivers for the message.</param>
        /// <param name="parameters">The parameters which will be replaced from the template to generate the message.</param>
        /// <returns>Returns a message created from the template.</returns>
        Message<TCustomData, TDestination> NewMessageFromTemplate<TCustomData, TDestination>(
            Template messageTemplate,
            TDestination from,
            IEnumerable<TDestination> toList,
            IDictionary<string, string> parameters)
            where TCustomData : MessageCustomData
            where TDestination : MessageDestination;

        /// <summary>
        /// Generates a new message from the template
        /// </summary>
        /// <typeparam name="TCustomData">The type of the custom data of the message (can be any value object inherited from MessageCustomData).</typeparam>
        /// <typeparam name="TDestination">The type of the destination (can be any value object inherited from MessageDestination).</typeparam>
        /// <param name="templateKey">The template key which will be processed.</param>
        /// <param name="from">The origin of the message.</param>
        /// <param name="toList">The list of receivers for the message.</param>
        /// <param name="parameters">The parameters which will be replaced from the template to generate the message.</param>
        /// <returns>Returns a message created from the template.</returns>
        Message<TCustomData, TDestination> NewMessageFromTemplate<TCustomData, TDestination>(
            string templateKey,
            TDestination from,
            IEnumerable<TDestination> toList,
            IDictionary<string, string> parameters)
            where TCustomData : MessageCustomData
            where TDestination : MessageDestination;

        /// <summary>
        /// Generates a new message from the template
        /// </summary>
        /// <typeparam name="TCustomData">The type of the custom data of the message (can be any value object inherited from MessageCustomData).</typeparam>
        /// <typeparam name="TDestination">The type of the destination (can be any value object inherited from MessageDestination).</typeparam>
        /// <param name="tenantId">The id of the tenant for which we shall attempt to find a customised template.</param>
        /// <param name="templateKey">The template key which will be processed.</param>
        /// <param name="from">The origin of the message.</param>
        /// <param name="toList">The list of receivers for the message.</param>
        /// <param name="parameters">The parameters which will be replaced from the template to generate the message.</param>
        /// <returns>Returns a message created from the template.</returns>
        Message<TCustomData, TDestination> NewMessageFromTemplate<TCustomData, TDestination>(
            long tenantId,
            string templateKey,
            TDestination from,
            IEnumerable<TDestination> toList,
            IDictionary<string, string> parameters)
            where TCustomData : MessageCustomData
            where TDestination : MessageDestination;
    }
}


